<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dfeofdm: XDfeOfdm_Trigger Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dfeofdm
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_dfe_ofdm___trigger.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XDfeOfdm_Trigger Struct Reference<div class="ingroups"><a class="el" href="group__dfeofdm.html">Overview</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Trigger configuration.  
 <a href="struct_x_dfe_ofdm___trigger.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a37c8475c743bbb66242ae0abdeba3be6"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___trigger.html#a37c8475c743bbb66242ae0abdeba3be6">TriggerEnable</a></td></tr>
<tr class="memdesc:a37c8475c743bbb66242ae0abdeba3be6"><td class="mdescLeft">&#160;</td><td class="mdescRight">[0,1], Enable Trigger:  <a href="#a37c8475c743bbb66242ae0abdeba3be6">More...</a><br/></td></tr>
<tr class="separator:a37c8475c743bbb66242ae0abdeba3be6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7588c100fa85f1c3921c785dc949577b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___trigger.html#a7588c100fa85f1c3921c785dc949577b">Mode</a></td></tr>
<tr class="memdesc:a7588c100fa85f1c3921c785dc949577b"><td class="mdescLeft">&#160;</td><td class="mdescRight">[0-3], Specify Trigger Mode.  <a href="#a7588c100fa85f1c3921c785dc949577b">More...</a><br/></td></tr>
<tr class="separator:a7588c100fa85f1c3921c785dc949577b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa7f0e1385ceb726bc0675cdbe6afc8f"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___trigger.html#afa7f0e1385ceb726bc0675cdbe6afc8f">TuserEdgeLevel</a></td></tr>
<tr class="memdesc:afa7f0e1385ceb726bc0675cdbe6afc8f"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">             [0-3], Specify either Edge or Level of the TUSER
</pre><p> input as the source condition of the trigger.  <a href="#afa7f0e1385ceb726bc0675cdbe6afc8f">More...</a><br/></td></tr>
<tr class="separator:afa7f0e1385ceb726bc0675cdbe6afc8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fa09d1d1e1eb52f107b13c4aee499e0"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___trigger.html#a1fa09d1d1e1eb52f107b13c4aee499e0">StateOutput</a></td></tr>
<tr class="memdesc:a1fa09d1d1e1eb52f107b13c4aee499e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">[0,1], Specify the State output value:  <a href="#a1fa09d1d1e1eb52f107b13c4aee499e0">More...</a><br/></td></tr>
<tr class="separator:a1fa09d1d1e1eb52f107b13c4aee499e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08962b0f9f87949435bb7d06891bc00f"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___trigger.html#a08962b0f9f87949435bb7d06891bc00f">TUSERBit</a></td></tr>
<tr class="memdesc:a08962b0f9f87949435bb7d06891bc00f"><td class="mdescLeft">&#160;</td><td class="mdescRight"><pre class="fragment">       [0-255], Specify which DIN TUSER bit to use as the source
</pre><p> for the trigger when MODE = 1 or 2.  <a href="#a08962b0f9f87949435bb7d06891bc00f">More...</a><br/></td></tr>
<tr class="separator:a08962b0f9f87949435bb7d06891bc00f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Trigger configuration. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a7588c100fa85f1c3921c785dc949577b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_Trigger::Mode</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>[0-3], Specify Trigger Mode. </p>
<p>In TUSER_Single_Shot mode, as soon as the TUSER_Edge_level condition is met, the State output will be driven to the value specified in STATE_OUTPUT. The Pulse output will pulse high at the same time. No further change will occur until the trigger register is re-written. In TUSER Continuous mode, each time a TUSER_Edge_level condition is met the State output will be driven to the value specified in STATE_OUTPUT This will happen continuously until the trigger register is re-written. The pulse output is disabled in Continuous mode:</p>
<ul>
<li>0 = IMMEDIATE: Applies the value of STATE_OUTPUT immediatetly the register is written.</li>
<li>1 = TUSER_SINGLE_SHOT: Applies the value of STATE_OUTPUT once when the TUSER_EDGE_LEVEL condition is satisfied.</li>
<li>2 = TUSER_CONTINUOUS: Applies the value of STATE_OUTPUT continually when TUSER_EDGE_LEVEL condition is satisfied.</li>
<li>3 = RESERVED: Reserved - will default to 0 behaviour. </li>
</ul>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, <a class="el" href="group__dfeofdm.html#ga8432ece95eb4a12d2f1eb60e87436809">XDfeOfdm_GetTriggersCfg()</a>, <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#ga5e4d810d0e04bbad650fbb60115254e4">XDfeOfdm_SetTriggersCfg()</a>.</p>

</div>
</div>
<a class="anchor" id="a1fa09d1d1e1eb52f107b13c4aee499e0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_Trigger::StateOutput</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>[0,1], Specify the State output value: </p>
<ul>
<li>0 = DISABLED: Place the State output into the Disabled state.</li>
<li>1 = ENABLED: Place the State output into the Enabled state. </li>
</ul>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga8432ece95eb4a12d2f1eb60e87436809">XDfeOfdm_GetTriggersCfg()</a>, and <a class="el" href="group__dfeofdm.html#ga5e4d810d0e04bbad650fbb60115254e4">XDfeOfdm_SetTriggersCfg()</a>.</p>

</div>
</div>
<a class="anchor" id="a37c8475c743bbb66242ae0abdeba3be6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_Trigger::TriggerEnable</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>[0,1], Enable Trigger: </p>
<ul>
<li>0 = DISABLED: Trigger Pulse and State outputs are disabled.</li>
<li>1 = ENABLED: Trigger Pulse and State outputs are enabled and follow the settings described below. </li>
</ul>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga8432ece95eb4a12d2f1eb60e87436809">XDfeOfdm_GetTriggersCfg()</a>, and <a class="el" href="group__dfeofdm.html#ga5e4d810d0e04bbad650fbb60115254e4">XDfeOfdm_SetTriggersCfg()</a>.</p>

</div>
</div>
<a class="anchor" id="a08962b0f9f87949435bb7d06891bc00f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_Trigger::TUSERBit</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">       [0-255], Specify which DIN TUSER bit to use as the source
</pre><p> for the trigger when MODE = 1 or 2. </p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, <a class="el" href="group__dfeofdm.html#ga8432ece95eb4a12d2f1eb60e87436809">XDfeOfdm_GetTriggersCfg()</a>, <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#ga5e4d810d0e04bbad650fbb60115254e4">XDfeOfdm_SetTriggersCfg()</a>.</p>

</div>
</div>
<a class="anchor" id="afa7f0e1385ceb726bc0675cdbe6afc8f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_Trigger::TuserEdgeLevel</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><pre class="fragment">             [0-3], Specify either Edge or Level of the TUSER
</pre><p> input as the source condition of the trigger. </p>
<p>Difference between Level and Edge is Level will generate a trigger immediately the TUSER level is detected. Edge will ensure a TUSER transition has come first:</p>
<ul>
<li>0 = LOW: Trigger occurs immediately after a low-level is seen on TUSER provided tvalid is High.</li>
<li>1 = HIGH: Trigger occurs immediately after a high-level is seen on TUSER provided tvalid is High.</li>
<li>2 = FALLING: Trigger occurs immediately after a high to low transition on TUSER provided tvalid is High.</li>
<li>3 = RISING: Trigger occurs immediately after a low to high transition on TUSER provided tvalid is High. </li>
</ul>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, <a class="el" href="group__dfeofdm.html#ga8432ece95eb4a12d2f1eb60e87436809">XDfeOfdm_GetTriggersCfg()</a>, <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#ga5e4d810d0e04bbad650fbb60115254e4">XDfeOfdm_SetTriggersCfg()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
